home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / statsq3c.zip / STATUSQ.DOC < prev    next >
Text File  |  1996-01-01  |  24KB  |  523 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                          Network Mail Status - QFront Version
  8.           ═════════════════════════════════════════════════════════════════
  9.  
  10.                First off I would like to thank Don Sharp who suggested this
  11.           version.  Also to all those who  offered suggestions and comments
  12.           on  my original Status  program. Some functions  and displays are
  13.           the  direct result of this input. Don  Sharp was a beta tester on
  14.           Status, StatusC and StatusQ.
  15.  
  16.                (1) Generates a network  Import mail status bulletin showing
  17.           each conference  (full 24 characters for  conference names), 1500
  18.           maximum, and  the total number  of messages imported  for current
  19.           date and total  to date for  each conferences, total  conferences
  20.           and the total messages to date for the specified network.
  21.  
  22.                (2) Generates a network  Export mail status bulletin showing
  23.           each conference  (full 24 characters for  conference names), 1500
  24.           maximum,  and the total  number of messages  exported for current
  25.           date and total  to date for  each conferences, total  conferences
  26.           and the total messages to date for the specified network.
  27.  
  28.                (3)  Generates  Last  Import bulletin  showing  last  import
  29.           information: date,  time, total messages imported  in last import
  30.           and total messages imported to date.
  31.  
  32.                (4)  Generates, or appends to  the end of,  a monthly totals
  33.           bulletin  called network.TOT  with each  rollover.  This bulletin
  34.           contains  the total  lines from  previous Import  bulletins along
  35.           with header.
  36.  
  37.                (5) Supports multiple network Import and Export bulletins in
  38.           addition to the regular bulletins above.
  39.  
  40.                This program  uses QFront's QSCAN.LOG(s). It  does a monthly
  41.           rollover  of  the  LOG(s)  using  PKWare's  PKZIP.EXE  (copyright
  42.           PKWare).
  43.  
  44.                This archive should contain the following files:
  45.  
  46.                CLEANUPQ.EXE.......... QFront log reduction program
  47.                CLEANUPQ.DOC.......... Instructions for running CleanUpQ
  48.                DOORS.TXT............. Current list of James Huckabey doors
  49.                FILE_ID.DIZ........... BBS description file
  50.                SOFTWARE.TXT.......... Information on shareware
  51.                HUCKABEY.TXT.......... Current list of all James Huckabey
  52.                                       software
  53.                ARCHIVE.TXT........... This list of files
  54.                READ.ME............... Update/changes information
  55.                STATUSQ.EXE........... Actual Status program
  56.                STATUSQ.DOC........... Instructions for running StatusQ
  57.                STATUSQ.CFG........... Sample configuration file     
  58.                STATUSQ2.CFG.......... Sample configuration file
  59.                STATUSQ3.CFG.......... Sample configuration file
  60.                STATUSQ.LUP........... Sample networks line up file
  61.  
  62.  
  63.  
  64.  
  65.  
  66.                Syntax is pretty straight forward:
  67.  
  68.  
  69.                                  STATUSQ STATUSQ.CFG
  70.  
  71.  
  72.                Full path  to STATUSQ.EXE may be  used if not in  path or in
  73.           current  directory.  If  you do  use  a  path  statement in  your
  74.           execution of Status (not in  current dir or in path) you  need to
  75.           set the  environment variable  "SET STATUSQ=path  to STATUSQ.EXE"
  76.           (SET STATUSQ=C:\UTILITY\OTHER, etc. no ending slash is needed).
  77.  
  78.                It  is  not  necessary  to  add  a  path  statement  to  the
  79.           configuration file since the program finds itself. Of  course the
  80.           file must  be in  location of STATUSQ.EXE.  If the  configuration
  81.           file  is not in the same location  then use the path statement to
  82.           it's location. 
  83.  
  84.                "STATUSQ.CFG" and can have any file name with the  following
  85.           format. You can  use up to 8 characters of  your network name for
  86.           the  name  of your  .CFG file  if  that helps  keep multi-network
  87.           configurations clearer. This would  be the easiest way to  do it.
  88.           Each  line must  be  populated  with  a  valid  entry.  Paths  to
  89.           bulletins or logs are not needed if they are in or written to the
  90.           current directory:
  91.  
  92.                          ( 1) Unregistered BBS
  93.                          ( 2) 0000
  94.                          ( 3) Network
  95.                          ( 4) QSCAN.LOG
  96.                          ( 5) C:\BBS\BLT1
  97.                          ( 6) C:\BBS\BLT2
  98.                          ( 7) C:\BBS\BLT3
  99.                          ( 8) PCB
  100.                          ( 9) Bright
  101.                          (10) STATUSQ.LUP
  102.  
  103.  
  104.                                      CFG line #1
  105.  
  106.                "Unregistered BBS", BBS name if registered.
  107.  
  108.  
  109.                                      CFG line #2
  110.  
  111.                "0000", valid serial number if registered.
  112.  
  113.  
  114.                                      CFG line #3
  115.  
  116.                "Network" should be the  name of the actual network  you are
  117.           using,  case sensitive (Fido 666,  Fido 144, etc.). 18 characters
  118.           max, longer names are truncated. Say you are making two different
  119.           network mail runs  with the  same software, you  would use  those
  120.  
  121.  
  122.  
  123.  
  124.  
  125.           names here, each in it's own configuration file.
  126.  
  127.                                      CFG line #4
  128.  
  129.                "QSCAN.LOG" is the path and name of your QFront scan log .
  130.  
  131.  
  132.                                      CFG line #5
  133.  
  134.                "C:\BBS\BLT1" is the path and name for your Import bulletin.
  135.  
  136.  
  137.                                      CFG line #6
  138.  
  139.                "C:\BBS\BLT2" is the path and name for your Export bulletin.
  140.  
  141.  
  142.                                      CFG line #7
  143.  
  144.                "C:\BBS\BLT3" is  the path  and name  for  your Last  Import
  145.           bulletin. If you are not  using this option the file can  just be
  146.           written out to the current directory, but it must be generated.
  147.  
  148.  
  149.                                      CFG line #8
  150.  
  151.                Color  and characters  used are  setup to  give you  as much
  152.           control over  the output as possible. Not  all users can read and
  153.           handle IBM extended graphic characters (like sight impaired users
  154.           and  voice  hardware). Program  can  use  either "=/-"  or  IBM's
  155.           extended graphic characters  "═/─". Line #8  must contain one  of
  156.           the following options:
  157.  
  158.                "PCB" use IBM extended  graphic characters and PCBoard's @X0
  159.           colorizing codes.
  160.  
  161.                "PCB2" use no IBM  extended graphic characters and PCBoard's
  162.           @X0 colorizing codes.
  163.  
  164.                "ANSI"   use   colorizing  and   no  IBM   extended  graphic
  165.           characters.
  166.  
  167.                "ANSI2" use colorizing and IBM extended graphic characters.
  168.  
  169.                "ASCII"  use  no  colorizing  and no  IBM  extended  graphic
  170.           characters.
  171.  
  172.                "ASCII2"  use no  colorizing, but  use IBM  extended graphic
  173.           characters.
  174.  
  175.  
  176.                                      CFG line #9
  177.  
  178.                Text Tone: This option  can be either Bright or  Normal. The
  179.  
  180.  
  181.  
  182.  
  183.  
  184.           default is BRIGHT. Even if you are using an ASCII option you must
  185.           still populate this option.
  186.  
  187.  
  188.                                      CFG line #10
  189.  
  190.               ** Networks option enabled with registration of StatusQ **
  191.  
  192.                ** The networks option is an  optional line in the CFG file.
  193.           Without it StatusQ runs  just like earlier versions and  does not
  194.           check for  a lineup  file. This  is in the  event you  are having
  195.           problems that this option can be disabled by removing it from the
  196.           CFG file.
  197.  
  198.                This  entry  in the  CFG  is  the  file  name for  the  Fido
  199.           individual Network bulletins (network line ups). File name can be
  200.           any legal DOS file name. Format as follows:
  201.  
  202.                     <position number one on each line (do not indent)
  203.  
  204.                     IMPORT:C:\PCB\BLTQIMP1     <import bulletin
  205.                     EXPORT:C:\PCB\BLTQEXP1     <export bulletin
  206.                     Fido 5666                  <network name
  207.                     Adult_Issues               <conference name
  208.                     Teen_Issues                <etc.
  209.                     Star_Trek
  210.  
  211.                First line must contain  import bulletin, second line export
  212.           bulletin and third line  network name. These are followed  by the
  213.           conferences belonging to that  individual network. You repeat the
  214.           process for each additional network:
  215.            
  216.                     <position number one on each line (do not indent)
  217.  
  218.                     IMPORT:C:\PCB\BLTQIMP1     <import bulletin
  219.                     EXPORT:C:\PCB\BLTQEXP1     <export bulletin
  220.                     Fido 5666                  <network name
  221.                     Adult_Issues               <conference name
  222.                     Teen_Issues                <etc.
  223.                     IMPORT:C:\PCB\BLTQIMP2
  224.                     EXPORT:C:\PCB\BLTQEXP2
  225.                     Fido 7684
  226.                     Men_Only
  227.                     Women_Only
  228.                     Teens_Only
  229.                     For_Sale
  230.  
  231.                IMPORT  and EXPORT  must be  uppercase and  use a  colon. NO
  232.           SPACE AFTER THE COLON. Borland's Turbo Pascal is unable to open a
  233.           file with a leading space, unlike DOS. The individual conferences
  234.           are  written out  in  sorted order  regardless  of how  they  are
  235.           entered in the  list. BUT they  must match existing  conferences.
  236.           There  is  a  maximum  of 500  conferences  for  each  individual
  237.           network. The network name has the same  18 character limit as the
  238.  
  239.  
  240.  
  241.  
  242.  
  243.           standard bulletins.  No Last Import bulletins  are generated. See
  244.           sample STATUSQ.LUP for additional information on format.
  245.  
  246.                It  is now possible to generate all manner of bulletins. You
  247.           can  have  like  minded  conferences in  different  networks  and
  248.           combine them into one bulletin. Say you have adult conferences in
  249.           several  Fido networks, now you can combine them together to make
  250.           "Fido  Adult" bulletins.  Say you  have genealogy  conferences in
  251.           several networks,  now  you can  combine  them together  to  make
  252.           "Genealogy" bulletins. There are endless possibilities.
  253.  
  254.                All networks  can be run from  separate configuration files,
  255.           but this means that StatusQ has to process all data each time. It
  256.           is faster, less wear and tare on hard drives, it all network data
  257.           is in one configuration file. If you want different formats, then
  258.           generate additional  configuration files to  generate the formats
  259.           desired.  Two  different  formats   require  only  two  different
  260.           configuration  files   (example:  STATUSQ.CFG/STATUSQ2.CFG).  The
  261.           networks file  (example: STATUSQ.LUP) also has  to have different
  262.           bulletin  names  in  it  or  it  will  overwrite  the  previously
  263.           generated bulletins.
  264.  
  265.  
  266.                                 STATUSQ TOTAL FILE(s)
  267.  
  268.                This  file,  StatusQ  Totals,  is  written  to  the  current
  269.           directory only. Current directory is the directory where you call
  270.           STATUSQ.EXE from.  The file name is the  first eight alphabetical
  271.           characters  of  your network  name. This  way  if you  are making
  272.           multiple network mail runs each network will have it's own totals
  273.           file. The extension is always "TOT".
  274.  
  275.                Please  make  note  that if  your  copy  of  StatusQ is  not
  276.           registered that the  total file will  have "Unregistered BBS"  in
  277.           the BBS line  of the bulletin. If you keep  the file and register
  278.           StatusQ  you will have  to edit the  top line of  the bulletin or
  279.           erase the file(s) and start over.
  280.  
  281.                This file/bulletin has  unlimited possibilities. If  you are
  282.           making  more  than  one  StatusQ  execution,  say  for  different
  283.           formats, only the first  one will be executed with  the rollover.
  284.           So this file will only contain  that color format. It is complete
  285.           with  whatever color codes existed  in the original bulletin. The
  286.           colors can be removed  or replaced with whatever colors  you want
  287.           manually using a text editor.
  288.  
  289.                The file has  a three  line header when  first created,  (1)
  290.           line with BBS name in it, (2) an explanation of what it is, (3) a
  291.           header  termination line.  It then  has one  line for  Import and
  292.           Export  totals   followed  by  a  blank   separation  line.  Each
  293.           successive  appendage  is two  lines  total.  A  year's worth  of
  294.           information would have a total of thirty-nine lines.
  295.  
  296.                What you do with this information is up to you. Just another
  297.  
  298.  
  299.  
  300.  
  301.  
  302.           friendly option added to the program. If you are going  to use it
  303.           as an  active bulletin it can  be copied anywhere  you want. Just
  304.           make sure  that if you want the next rollover appended to the end
  305.           that you keep the file in the current directory for the execution
  306.           of StatusQ. If you change  this directory make sure you move  the
  307.           total bulletin(s) to your new directory.
  308.                    Special Bulletins Showing Totals Each Conference
  309.  
  310.                It  is  possible  to  make  a  "Previous  Month's"  activity
  311.           bulletin out of the  rolled over log(s). At least the  data would
  312.           be all  there and compacted  if you have  used CleanUpQ.  All you
  313.           have to  do is make a  special STATUSQ.CFG file with  the name of
  314.           the  bulletins for these special bulletins. You could do one each
  315.           month  for the previous month.  The bulletin for  the Last Import
  316.           could just be written to the  current directory and not used. For
  317.           a  full month the Bulletins would have something like 01-01-95 to
  318.           01-31-95 for the time period as this  would be the dates in a log
  319.           for January 1995.
  320.  
  321.                Of  course the  above would  work even  if you  did not  run
  322.           CleanUpQ.
  323.  
  324.                It should be noted that when you start using StatusQ for the
  325.           first time  that if your QFront  log(s) are not  just the current
  326.           month's log(s) that the log does not roll over until the month in
  327.           the log  equals your  system's current  month. The  first archive
  328.           will  contain everything to last  day of previous  month. The new
  329.           log will start at the first current month's date StatusQ finds in
  330.           the   current  month's   log.  Bulletins   generated  will   show
  331.           information only for  the current  month and from  this point  on
  332.           each roll over  archive will  contain only  the previous  month's
  333.           log.
  334.  
  335.  
  336.                                         Errors
  337.  
  338.                Errors are written to the same directory as STATUSQ.EXE in a
  339.           file called  STATUSQ.ERR. If  the file already  exists additional
  340.           errors  are appended to  the end of  the file. It  may be deleted
  341.           after you  have made note  of any errors.  It's existence it  not
  342.           required by the program.
  343.  
  344.                During  the  start  up   procedures  that  program  displays
  345.           "Searching!"/"Configuring!" while it is reading in and  verifying
  346.           all  information in the configuration file. These are to show you
  347.           what the program  is doing should  lockups occur. Normally  these
  348.           two  displays should  be very  quick and unreadable  depending on
  349.           system speed and StatusQ's configuration.
  350.  
  351.                The  program confirms  each item  in the  configuration file
  352.           before it  does  anything else.  Program  aborts if  each  option
  353.           cannot be confirmed.
  354.  
  355.                If the program has any problems with  your log(s) such as no
  356.  
  357.  
  358.  
  359.  
  360.  
  361.           conferences found or log not found, bulletins (Import and Export)
  362.           are generated showing "No  data found" and the error  information
  363.           is written to STATUSQ.ERR.
  364.  
  365.  
  366.  
  367.  
  368.  
  369.                               Making Different Bulletins
  370.  
  371.                Perhaps you want to  make a bulletin with the  PCBoard color
  372.           codes  and one using straight  ASCII codes and  yet another using
  373.           ANSI codes, Bright  or Normal  Text Tones. The  .CFG files  would
  374.           contain the bulletin names and the form setting (#9):
  375.  
  376.                STATUSQ STATUSQ.CFG
  377.                (.CFG with PCB, uses PCBoard color codes and IBM extended
  378.                 graphic characters and normal text tone)
  379.  
  380.                STATUSQ STATUSQ2.CFG
  381.                (.CFG with ASCII, ASCII and no IBM extended graphic
  382.                 characters and normal text tone [must be populated])
  383.  
  384.                STATUSQ STATUSQ3.CFG
  385.                (.CFG with ANSI, ANSI colors and no IBM extended graphic
  386.                 characters and bright text tone)
  387.  
  388.                You just call STATUSQ as many  times as needed, with as many
  389.           configuration files  as needed  to generate whatever  formats you
  390.           want. On my 486DX4 100  it takes less than ten seconds to run the
  391.           program on a 16,500 line test log.
  392.  
  393.  
  394.  
  395.  
  396.  
  397.                         PKZIP.EXE used by the StatusQ Program
  398.  
  399.                "PKZIP.EXE" must be somewhere in your path or in the current
  400.           directory. When  the month  changes in the  export/import.log the
  401.           program  archives the  current log  into a  file using  'SQ'+ the
  402.           current date  (SQ010195.ZIP, etc.). It also  includes the current
  403.           logs and all  bulletins. It  creates this in  the directory  that
  404.           contains the log file(s). The program then rewrites the log using
  405.           only the  current new month's  data. This  way there is  only one
  406.           month's log data in your QFront log(s).
  407.  
  408.                The  bulletins  are  added  to   the  archive  so  the  last
  409.           information posted on the BBS before rollover is available should
  410.           this information be required by you.
  411.  
  412.                If you do not want the previous month's log(s) simply delete
  413.           the archive from your hard drive. In your calling batch  file you
  414.           can  add "IF EXIST SQ*.ZIP DEL SQ*.ZIP" and this will auto-delete
  415.           the archive.
  416.  
  417.                There must  be at least one  meg of free disk  space for the
  418.           archive to be executed. I have no idea the possible  sizes and if
  419.           anyone has problems with the archive with one meg as the  minimum
  420.           please let me know and I will increase the size of the free space
  421.           required. 
  422.  
  423.  
  424.  
  425.  
  426.  
  427.                                  The StatusQ Program
  428.  
  429.                If you don't like the program please write to me and explain
  430.           why. Send me any suggestions you  might have. If they enhance the
  431.           overall program I will try to incorporate part, some, all, in the
  432.           next release.
  433.  
  434.                 This program package represents  many hours of programming,
  435.           testing, updating and LD telephone calls  to get it tested and to
  436.           distribute the beta and release copies. Please support my efforts
  437.           and  register your  copy. Registration  enables CleanUpQ  and the
  438.           Networks option.
  439.  
  440.  
  441.                                  StatusQ Registration
  442.  
  443.                Please  supply name  of BBS to  be added  to program,  up to
  444.           sixty  characters. Anything  longer  than this  is truncated,  no
  445.           exceptions. This is to be on one line of code and must be legible
  446.           since the  serial number is  based on  exact syntax. I  cannot be
  447.           responsible for unreadable data. Please print. Case sensitive! 
  448.  
  449.                For  those who  do  not understand  "case sensitive"  I will
  450.           explain since  some people do not  seem to know the  term. If you
  451.           send me  your BBS name in  all capital letters that  is what your
  452.           serial number matches. If you send  me your BBS name in all lower
  453.           case letters your this is what your serial number matches. If you
  454.           send  me your BBS name in capital  and lower case letters that is
  455.           what your serial number matches. Writing small capital letters is
  456.           not the same as lower case. I have gotten registrations where the
  457.           first letter of words were in  large capital letters and the rest
  458.           of  the letters  in  that  word  in  small  capital  letters.  My
  459.           interpretation is  that this is all  uppercase (capital) letters.
  460.           By match means that your configuration file must contain the same
  461.           format your serial number is based on: (1) all uppercase, (2) all
  462.           lower case, (3) mixed case.
  463.  
  464.           Example:  "Jim's Graphic  BBS". In  StatusQ it  comes out  as the
  465.           following in all bulletins generated:
  466.  
  467.                ==================(Jim's Graphic BBS)==================
  468.  
  469.  
  470.  
  471.  
  472.  
  473.                               StatusQ Registration Form
  474.  
  475.  
  476.            [-------------------------------------------------------------]
  477.  
  478.                                  (put BBS name above)
  479.  
  480.                Send BBS information and one of the following in U.S.$
  481.  
  482.                (1) Registration via mail.............................$15
  483.                    (outside U.S./Canada please add $2)
  484.  
  485.                (2) Update from version 1 or 2 via mail only..........$3
  486.  
  487.                (3) Registration and latest version via mail......... $17
  488.                    (outside U.S./Canada please add $4) Include diskette
  489.                    size.
  490.  
  491.                (4) Registration and latest copy of all James Huckabey
  492.                    software (BBS and regular PC).....................$18 
  493.                    (outside U.S./Canada please add $4) Include diskette
  494.                    size.
  495.  
  496.                         Option: 1: [ ]     2: [ ]     3: [ ]     4: [ ]
  497.  
  498.                Diskette Size: 360: [ ]   1.2: [ ]   720: [ ]  1.44: [ ]
  499.  
  500.                Your current version number: [     ]
  501.  
  502.           FROM: 
  503.                   Name: 
  504.                        ---------------------------------------------------
  505.                Address:  
  506.                        ---------------------------------------------------
  507.                   City: 
  508.                        ---------------------------------------------------
  509.            State & Zip: 
  510.                        ---------------------------------------------------
  511.               BBS Name:
  512.                        ---------------------------------------------------
  513.           Phone(voice):                       (data)
  514.                        ----------------------        ---------------------
  515.  
  516.  
  517.                Your registration  number and  any diskettes,  if requesting
  518.           current version or other software, are sent by return mail.
  519.  
  520.                       James Huckabey
  521.                       3621-A Fraser Street
  522.                       Bellingham, Washington 98226-2473 U.S.A.
  523.                       (360) 671-2868 (voice, Pacific)